GNSS 20 Click Driver

API for configuring and manipulating GNSS 20 Click driver. More...

Topics
	GNSS 20 Device Settings
	Settings for registers of GNSS 20 Click driver.
	GNSS 20 MikroBUS Map
	MikroBUS pin mapping of GNSS 20 Click driver.

Functions
void	gnss20_cfg_setup (gnss20_cfg_t *cfg)
	GNSS 20 configuration object setup function.
void	gnss20_drv_interface_sel (gnss20_cfg_t *cfg, gnss20_drv_t drv_sel)
	GNSS 20 driver interface setup function.
err_t	gnss20_init (gnss20_t *ctx, gnss20_cfg_t *cfg)
	GNSS 20 initialization function.
err_t	gnss20_generic_write (gnss20_t *ctx, uint8_t *data_in, uint16_t len)
	GNSS 20 data writing function.
err_t	gnss20_generic_read (gnss20_t *ctx, uint8_t *data_out, uint16_t len)
	GNSS 20 data reading function.
uint8_t	gnss20_get_pps_pin (gnss20_t *ctx)
	GNSS 20 get PPS pin function.
void	gnss20_set_rst_pin (gnss20_t *ctx, uint8_t state)
	GNSS 20 set RST pin function.
void	gnss20_reset_device (gnss20_t *ctx)
	GNSS 20 reset device function.
err_t	gnss20_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
	GNSS 20 parse GGA function.

Detailed Description

API for configuring and manipulating GNSS 20 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

gnss20_cfg_setup()

void gnss20_cfg_setup

(

gnss20_cfg_t *

cfg

)

GNSS 20 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See gnss20_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

gnss20_drv_interface_sel()

void gnss20_drv_interface_sel	(	gnss20_cfg_t *	cfg,
		gnss20_drv_t	drv_sel )

GNSS 20 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters

[out]	cfg	: Click configuration structure. See gnss20_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See gnss20_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

gnss20_generic_read()

err_t gnss20_generic_read	(	gnss20_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

GNSS 20 data reading function.

This function reads a desired number of data bytes by using the selected serial interface.

Parameters

[in]	ctx	: Click context object. See gnss20_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

gnss20_generic_write()

err_t gnss20_generic_write	(	gnss20_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

GNSS 20 data writing function.

This function writes a desired number of data bytes by using the selected serial interface.

Parameters

[in]	ctx	: Click context object. See gnss20_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss20_get_pps_pin()

uint8_t gnss20_get_pps_pin

(

gnss20_t *

ctx

)

GNSS 20 get PPS pin function.

This function returns the pulse per second (PPS) pin logic state.

Parameters

[in]

ctx

: Click context object. See gnss20_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

gnss20_init()

err_t gnss20_init	(	gnss20_t *	ctx,
		gnss20_cfg_t *	cfg )

GNSS 20 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See gnss20_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See gnss20_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss20_parse_gga()

err_t gnss20_parse_gga	(	uint8_t *	rsp_buf,
		uint8_t	gga_element,
		uint8_t *	element_data )

GNSS 20 parse GGA function.

This function parses the GGA data from the read response buffer.

Parameters

[in]	rsp_buf	: Response buffer.
[in]	gga_element	: GGA element position [1-14].
[out]	element_data	: Element data parsed.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss20_reset_device()

void gnss20_reset_device

(

gnss20_t *

ctx

)

GNSS 20 reset device function.

This function resets the device by toggling the RST pin.

Parameters

[in]

ctx

: Click context object. See gnss20_t object definition for detailed explanation.

Returns

None.

Note

None.

gnss20_set_rst_pin()

void gnss20_set_rst_pin	(	gnss20_t *	ctx,
		uint8_t	state )

GNSS 20 set RST pin function.

This function sets the RST pin logic state.

Parameters

[in]	ctx	: Click context object. See gnss20_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.